Yandex Mobile Ads/com.yandex.mobile.ads.common/YandexAds

YandexAds

Class contains logic that applies to the Mobile Ads SDK as a whole. Right now, the only methods in it are used for enabling SDK logs, getting SDK version and enabling visibility error indicator.

Properties

adVolumeController

@JvmStatic

val adVolumeController: AdVolumeController

Controls audio of ads rendered by the SDK — mute and volume for every ad format except In-Stream.

libraryVersion

@JvmStatic

val libraryVersion: String

Returns the SDK version in the X.Y.Z format.

Functions

enableDebugErrorIndicator

@JvmStatic

fun enableDebugErrorIndicator(enableIndicator: Boolean)

Enable or disable visibility error indicator in Debug Mode. Indicator is enabled by default.

enableLogging

@JvmStatic

fun enableLogging(enableLogging: Boolean)

Enables SDK logs. Logs are disabled by default.

initialize

@JvmStatic

fun initialize(context: Context, initializationListener: InitializationListener)

Initializes the Yandex Mobile Ads SDK internal state.

setAdapterIdentity

@JvmStatic

fun setAdapterIdentity(adapterIdentity: AdapterIdentity)

Sets the adapter identity for mediation. AdapterIdentity will be stored globally and automatically added to all requests. Call before initialize when using mediation adapters.

setAgeRestricted

@JvmStatic

fun setAgeRestricted(ageRestricted: Boolean)

Set a value indicating whether user is a child or undefined age. If the value is set to true personal data will not be collected.

setAppAdAnalyticsReporting

@JvmStatic

fun setAppAdAnalyticsReporting(reportingEnabled: Boolean)

Enable or disable reporting for ad events that are automatically sent to AppMetrica for applications. App ad analytics enabled by default.

setLocationTracking

@JvmStatic

fun setLocationTracking(enabled: Boolean)

Enables location usage for ad loading. Disabled by default Location permission is still required to be granted additionally to the consent.

setUserConsent

@JvmStatic

fun setUserConsent(consent: Boolean)

Set a value indicating whether user from GDPR region allowed to collect personal data which is used for analytics and ad targeting. If the value is set to false personal data will not be collected.

showDebugPanel

@JvmStatic

fun showDebugPanel(context: Context)

Launches SDK debug panel.